/* -*-c++-*- */
/* osgEarth - Geospatial SDK for OpenSceneGraph
* Copyright 2020 Pelican Mapping
* http://osgearth.org
*
* osgEarth is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program.  If not, see <http://www.gnu.org/licenses/>
*/

#ifndef OSGEARTH_CACHE_SEED_H
#define OSGEARTH_CACHE_SEED_H 1

#include <osgEarth/Common>
#include <osgEarth/TileKey>
#include <osgEarth/TileVisitor>

namespace osgEarth {
    class Map;
}

namespace osgEarth { namespace Contrib
{
    using namespace osgEarth::Util;

    /**
    * A TileHandler that caches tiles for the given layer.
    */
    class OSGEARTH_EXPORT CacheTileHandler : public TileHandler
    {
    public:
        CacheTileHandler( TileLayer* layer, const Map* map );
        virtual bool handleTile( const TileKey& key, const TileVisitor& tv );
        virtual bool hasData( const TileKey& key ) const;

        virtual std::string getProcessString() const;

    protected:
        osg::ref_ptr< TileLayer > _layer;
        osg::ref_ptr< const Map > _map;
    };    

    /**
    * Utility class for seeding a cache
    */
    class OSGEARTH_EXPORT CacheSeed
    {
    public:
        CacheSeed();

        /**
        * Gets the TileVisitor to use when seeding the cache.  Use this to set traversal options like the extents, levels, etc.
        */
        TileVisitor* getVisitor() const;

        /**
        * Sets the TileVisitor to use when seeding the cache.  Must be configured BEFORE you call run
        */
        void setVisitor(TileVisitor* visitor);

        /**
        * Seeds a TileLayer
        */
        void run(TileLayer* layer, const Map* map );


    protected:

        osg::ref_ptr< TileVisitor > _visitor;
    };
} }

#endif //OSGEARTH_CACHE_SEED_H
